home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / bbs / cl14s24a.zip / CONFIG.DOC < prev    next >
Text File  |  1992-12-07  |  38KB  |  787 lines

  1. Since I added alot of entries to the CALLS.CNF file, I thought it was time
  2. I wrote a document to explain them in more detail. I will also give you an
  3. explination of the entries that Sam Smith created.
  4.  
  5. Almost all entries have a default value and if there is not an entry or you
  6. comment out the entry then the default will be used. The entries may be made
  7. in any order you like and if you duplicate one, the last one will be the one
  8. to take affect. ON, YES and TRUE are all acceptable states for the below
  9. options and any other answer will be considered the same as OFF, NO and FALSE.
  10.  
  11. *---------------------------------------------------------------------------
  12. ;full name of caller input file (or NUL) - Default = CALLER
  13. INFILE  C:\PCB\MAIN\CALLER
  14.  
  15. This is the file to be read and processed. If you are running a single node
  16. and specify NODE 1 then this will be the complete filename used. If you
  17. specify NODE 2 (or higher) then CALLS.EXE will append a '1' to the filename
  18. and process that file, then append a '2' and process that, etc.. until it
  19. has processed all CALLER files uo to the value you assign to NODE.
  20.  
  21. *---------------------------------------------------------------------------
  22. ;output file to produce - Default = BLT99
  23. OUTFILE C:\PCB\GEN\BLT11
  24.  
  25. This is the file to send the output to. If you specify BOTH or ANSI for
  26. REPORTTYPE then a 'G' will be appended to the filename and an ANSI report
  27. generated. If you use a full 8 character filename then when the 'G' gets
  28. appended DOS will still interpet the same filename and you will only get 1
  29. report in ASCII if you specified BOTH unless you specify a '.' at the end
  30. of the filename in which case CALLS.EXE can properly append a 'G' to it.
  31.  
  32. *---------------------------------------------------------------------------
  33. ;input file of a Header to precede report - Default = NUL
  34. ;HEADER C:\PCB\GEN\BLT11.HD
  35.  
  36.  
  37. This file (if it is found to exist) will be read just prior to outputing
  38. the report and will be output to the report. It will be output just after
  39. the @CLS@ if you have a '*' as the first character of REPORTS. If you
  40. specify ANSI or BOTH then a 'G' will be appended to the filename and be
  41. used for the ANSI version of the output (note the same notes regarding
  42. the appending as above). If the 'G' version does not exist, then no header
  43. will be used for the ANSI version.
  44.  
  45. *---------------------------------------------------------------------------
  46. ;file for saved history information (or NUL) - Default = CALLS.SAV
  47. SAVEFILE CALLS.SAV
  48.  
  49. If not set to NUL, then this file will be read before beginning the processing
  50. of the INFILE(s) and saved after writing the OUTFILE. This allows reading
  51. the CALLERS file each day and then discarding it. The totals will be
  52. accumulated in CALLS.SAV each time. Also if you like seperate bulletins to
  53. be generated for the different reports, you can have multiple .CNF files and
  54. in the first specify an INFILE and a SAVEFILE and the first OUTFILE. Then
  55. in additional .CNF files set for different REPORTS, you can specify NUL for
  56. INFILE to indicate no file processing be done, and reports wil be generated
  57. from the totals in the SAVEFILE which allows for quick generation of reports.
  58. Change the OUTFILE for each report to be generated.
  59.  
  60. *---------------------------------------------------------------------------
  61. ;report subtitle (for Report A, Systems Statistics)
  62. ;SUBTITLE My BBS Activity Report
  63.  
  64. If defined, this prints after the report title for the Systems Statistics
  65. Report (A).
  66.  
  67. *---------------------------------------------------------------------------
  68. ;file for outputting any unknown line for study (or NUL) - Default = NUL
  69. UNKNOWNFILE UNKNOWN.TXT
  70.  
  71. New to CALLS 14S23D is the addition of symbols to the end of the data lines
  72. written to the UNKNOWN.TXT file. These will identify Unknown, CatchAll and
  73. Junk lines (both normal and within Doors) and any lines not marked are known
  74. lines being written related to DOORS. (ie. DOORREPORT or UNKNOWNDOORREPORT)
  75. This file is for troubleshooting and was used by me in generating data. It
  76. allows for sending certain lines read to a file given the following conditions:
  77.  
  78. *-----
  79. ;include all unknown lines in unknown file - Default = YES
  80. UNKNOWNREPORT YES
  81.  
  82. Any line that is not specifically recogonized by CALLS.EXE for processing will
  83. be dumped to the file specified in UNKNOWNFILE. This allows recoginizing what
  84. changes might need to be made to CALLS.EXE for future enhancements. It can
  85. also allow you to spot errors in setup. I intentionally do not recoginze
  86. certain error messages that PCBoard generates, so if they pop up in the
  87. UNKNOWNFILE I can see them right away, whereas I might miss them when checking
  88. the CALLERS file.
  89.  
  90. *-----
  91. ;include all Junk lines in unknown file - Default = NO
  92. ;junk lines are those recognized by CALLS and skipped over.
  93. JUNKREPORT YES
  94.  
  95. Certain line are recognized by CALLS.EXE but not processed in anyway. They are
  96. only recoginized to prevent them from being written to UNKNOWNFILE. If you want
  97. to see what they are, set this to YES. If there is some data that you feel
  98. should be reported in some useful way, let me know.
  99.  
  100. *-----
  101. ;include all Door Unknown, Catchall and Junk lines in unknown file
  102. ;This refers to only those doors known to CALLS - Default = YES
  103. DOORJUNKREPORT NO
  104.  
  105. This is identical to JUNKREPORT, CATCHALLREPORT and UNKNOWNREPORT but
  106. controls those type of entries only while in a door and only for the
  107. Doors that CALLS has specific reports for. This allows for finding missed
  108. or new lines that a door is generating that CALLS does not know yet.
  109.  
  110. *-----
  111. ;include all Catchall lines in unknown file - Default = NO
  112. ;Catchall lines are those recognized by CALLS in the Catchall routine which
  113. ;picks up lines missed by the normal scan (some just have to be done this way)
  114. CATCHALLREPORT YES
  115.  
  116. Some lines (like conferences joined) just had to pass thru the catchall
  117. routine. Those that had to pass that way will not reported by setting this
  118. to YES. Others that were in the routine, that I could not figure out why they
  119. were there as they were already trapped for previously, will be reported if
  120. this is set to YES and they get caught in the CATCHALL routine. If they don't
  121. don't ever show up then I will remove those lines of code.
  122.  
  123. The way processing is done in order to speed up the recognition of the lines
  124. is to first process the first (position 7) character of the line and then
  125. scan for data in in a CASE statement based on the first character, if the
  126. line is not recognized then it passes to the CatchAll routine. This is
  127. conferences joined have to be caught in the catchall routine. The conference
  128. name is the first thing on the line so the first letter could be anything.
  129.  
  130. *-----
  131. ;include all Door lines in unknown file - Default = NO
  132. DOORREPORT NO
  133.  
  134. If set to YES then everything from the OPENED DOOR (xxxxx) AT HH:MM to
  135. the BACK TO DOS AT HH:MM will be sent to the UNKNOWNFILE (if the line is
  136. unrecognized then it will be echoed twice if UNKNOWNREPORT is set to YES).
  137. This allows for troubleshooting the door reports or gathering info for
  138. building your own report.
  139.  
  140. *-----
  141. ;include all Unknown Door lines in unknown file - Default = YES
  142. ;This refers to all Doors that are not known to CALLS.
  143. UNKNOWNDOORREPORT NO
  144.  
  145. This is identical to DOORREPORT but will send data only on Doors that CALLS
  146. does not know (those it does not have a specific report for). It is only
  147. active when DOORREPORT is not, as ALL Door lines go to the report when
  148. DOORREPORT is set to YES. This will allow for finding more doors that
  149. justify a report.
  150.  
  151. *-----
  152. ;List of Doors for CALLS to consider known. (seperate doors with '/')
  153. ;KNOWNDOORS REMOTE/LOTTO
  154.  
  155. This allows you to list Doors which you don't want UNKNOWNDOORREPORT to
  156. include. The only purpose of including a door here is to stop CALLS from
  157. writing lines to UNKNOWN.TXT when UNKNOWNDOORREPORT is set to YES. Any
  158. Door that matches one named in the list will not generate lines.
  159.  
  160. *---------------------------------------------------------------------------
  161. ;List of Doors for CALLS to consider chat doors. (seperate doors with '/')
  162. ;CHATDOORS TALK2ME/CHATDOOR/HELLO!
  163.  
  164. This expands on the new code that counts Doors opened with the text 'CHAT'
  165. in them to be counted as Node Chats by allowing a list of doors that are
  166. Chat Doors and should be counted as a Node Chat.  Time spent in Door will
  167. also be counted as Node Chat Time as well as Time Spent in Door.
  168.  
  169. *---------------------------------------------------------------------------
  170. ;number of nodes to scan (1=single node mode) - Default = 1
  171. NODES   1
  172.  
  173. This is the number of nodes that you want to scan and will cause a number
  174. to be appended to the INFILE name and each file ot be processed in sequence
  175. as described under INFILE. If you only run a single node then set this to 1.
  176. If you run a single node but have PCBoard set for multiple nodes so that the
  177. CALLER file is named CALLER1 then you will need to specify CALLER1 under
  178. OUTFILE and set NODE to 1.
  179.  
  180. *---------------------------------------------------------------------------
  181. ;list of nodes (in order of desired scan, NODES should equal the number of
  182. ;nodes included in the list. If no list provided then all nodes will be
  183. ;scanned from 1 to NODES)
  184. ;NODES 3
  185. ;NODELIST 5 3 1
  186.  
  187. This allows you more control over scanning multi-node setups. You can easily
  188. scan only some of your nodes without having to run the program several times
  189. using a CALLS.SAV file to collect the data. Try to make sure that NODES matches
  190. the number of of entries in the list, although provisions have been made to
  191. ensure that CALLS will not care. If there are more entries they will be
  192. ignored, and if there are less entries CALLS just ignore the fact, just by
  193. being careful, you will save yourself some headaches trying to figure out why
  194. some nodes don't show up.
  195.  
  196. *---------------------------------------------------------------------------
  197. ;list of reports to produce from the following list
  198. ; Default = A+NSTBCXO!RPDEVU^-F=GY1Y2Y3Y4Y5Y6Y7Y8Y9Y10#HIJKLQ&M
  199. ;
  200. ;   A - system statistics            B - graphic modes
  201. ;   C - baud rates                   D - hourly usage
  202. ;   E - conferences joined           F - bulletins read
  203. ;   G - doors opened                 H - download protocols
  204. ;   I - download efficiency          J - upload protocols
  205. ;   K - upload efficiency            L - batch sizes
  206. ;   M - files downloaded             N - security statistics
  207. ;   O - security level counters      P - connect type analysis
  208. ;   Q - free downloads *Not PCB*     R - Minutes used by Security
  209. ;   S - Sysop Statistics             T - User Statistics
  210. ;   U - User Messages                V - Conf Messages
  211. ;   W - Event Report                 X - Language Report
  212. ;   Y - Door Report                  Z - insert a blank line
  213. ;   @ - insert a @MORE@ prompt       $ - insert a @PAUSE@ prompt
  214. ;   % - insert a @WAIT@ prompt       * - insert a @CLS@
  215. ;   ! - Last Called In Report        # - Message Statistics
  216. ;   = - Time Spent in Doors Report   ^ - User Uploads
  217. ;   - - Callers Hanging Up           & - Caller ID Report
  218. ;   + - File Transfer Statsistics    _ - Voting Issues
  219. ;
  220. ; Door Reports are followed by number
  221. ;   1 - InstaReg                     2 - PCBVerify
  222. ;   3 - Callback                     4 - Depository
  223. ;   5 - MailDoor (Generic)           6 - QMail
  224. ;   7 - MarkMail                     8 - User Definable
  225. ;   9 - Voter Plus                  10 - Swop
  226. ;
  227. REPORTS *A+NZSTZBCDXO!RPEVU^-F=GY1ZY2Y3ZY4Y5ZY6Y7ZY8Y9Y10#HIJKL&MW%
  228.  
  229. This controls which reports and in which order they will be issued to the
  230. OUTFILE. If a '*' is placed as the first character then a @CLS@ will be sent
  231. to the OUTFILE before anything else. Each character controls a single report
  232. except for Y which requires two characters (Y1 ... Y8).
  233.  
  234. *---------------------------------------------------------------------------
  235. ;Exclude accumulation of Data for graph reports - Default - None
  236. ;Allowable entries are (CEFGLOPQRUVWX!=^-&_)
  237. ;REPORTEXCLUDE C
  238.  
  239. This allows you to prevent the collection of data which you will not be using
  240. which can offer a slight speed improvement and most importantly, reduce the
  241. size of the SAVEFILE when accululating data over long periods of time. Note:
  242. If you exclude any report data, then it will not be accumlated and saved in
  243. the SAVEFILE and you will not be able to report on it in the future without
  244. rescanning old CALLER files.
  245.  
  246. *---------------------------------------------------------------------------
  247. ;Action to perform after each section
  248. ;Allowable entries are (Z@$%*)
  249. REPORTACTION Z%*
  250.  
  251. After every report control character in REPORTS, the string in REPORTACTION
  252. will be processed UNLESS the next character in REPORTS is one of the
  253. characters (Z@$%*.) in which case REPORTACTION will not be processed for that
  254. report. This allows you to perform a @WAIT@ and @CLS@ after EVERY report, yet
  255. prevent the action from occuring on certain reports that you want to combine.
  256. The '.' is a do nothing character that is used to stop the REPORTACTION without
  257. the need to do anything else. The others are described in REPORTS.
  258.  
  259. *---------------------------------------------------------------------------
  260. ;Type of report to output, ASCII, ANSI, BOTH or PCBOARD - Default - BOTH
  261. REPORTTYPE PCBOARD
  262.  
  263. This allows you to control what type of report format you output. ASCII is
  264. a straight text file. ANSI is a colorized version using ANSI escape sequences,
  265. and a 'G" is appended to the OUTFILE and HEADER filenames. BOTH will cause
  266. both an ASCII and ANSI report. A setting of PCBOARD will cause a single report
  267. (with no 'G' appended to filenames) to be output using @Xnn color codes.
  268. In all cases the reports will be generated with @MORE@, @PAUSE@ and @WAIT@
  269. prompts if the are specified. For ASCII and PCBOARD, a @CLS@ will be used but
  270. for ANSI a <ESC>[2J sequence will be issued.
  271.  
  272. *---------------------------------------------------------------------------
  273. ;peak hours to report
  274. ;                  11111111112222
  275. ;        012345678901234567890123
  276. ;PEAK    YNNNNNNNNNNNNNNNNYYYYYYY
  277.  
  278. ;determine peak 6 hours automatically (or number of hours specified)
  279. ;PEAK AUTO 8
  280. PEAK AUTO
  281.  
  282. This will be used to control which times are used when calcluating the
  283. Peak Utilization %...    xx.x line. The hours marked with a 'Y' will be
  284. included in the peak calculation.  If set to AUTO then CALLS will determine
  285. the peak 6 hours automatically. You may also specify the number of hours
  286. to report as peak after AUTO, ie. AUTO 8 (Note: this does not refer to
  287. a consecutive number of hours to be considered as a peak time block. The
  288. hours will be sorted by value and the top number of hour specified will be
  289. flagged as PEAK hours.)
  290.  
  291. *---------------------------------------------------------------------------
  292. ;shorten graph to just percentage used - Default = no
  293. ;NO/YES/or the minumum percent to start at
  294. SHORTENGRAPH 50
  295.  
  296. If set to NO the the full hourly usage chart will be generated. If set to YES
  297. then only the portion that is needed (the maximum usage) will be generated.
  298. If set to a value (0 to 100 in multiples of 5) then either the maximum usage
  299. or the value set will be generate, which ever is higher. This allows you to
  300. limit the number of blank lines that are generated by keeping the report to
  301. just those lines needed without shrinking the report too small to look good.
  302.  
  303. *---------------------------------------------------------------------------
  304. ;full name of Sysop or SYSOP
  305. SYSOPNAME GARY MEEKER
  306.  
  307. This allows CALLS.EXE to recoginze you as the SYSOP when reporting local or
  308. remote Sysop sessions. If you have PCBoard use your name then place that here
  309. or if you have it use SYSOP then specify SYSOP here.
  310.  
  311. *---------------------------------------------------------------------------
  312. ;First Name to Exclude from stats (RNET.EXE is always excluded)
  313. ; up to 10 entries are allowed (this is not for USER names!)
  314. ;EXCLUDENAME RNET.EXE
  315.  
  316. This allows you to specify program names that generate logons that look just
  317. like a User from being incuded in the report or prematurely stopping the
  318. event timing. RNET.EXE is one such example is is already handled by CALLS.EXE
  319. and need not be specified here. You can have up to 10 entries and more will
  320. be ignored.
  321.  
  322. *---------------------------------------------------------------------------
  323. ;Full User Name to exclude from stats (User Messages Left, Uploads and
  324. ; Caller Hungup Reports). Up to 50 entries are allowed.
  325. ; Adding '*' as first character of name will flag User as a NetUser.
  326. ;EXCLUDEUSER GARY MEEKER
  327.  
  328. This allows you to exclude Users from being included in the reports mentions
  329. above. If you are a HUB then you can include your NODE names from these
  330. reports or exclude yourself if you like. Flagging a User as a NetUser will
  331. cause messages left by this User to count as Net Mail instead of Mail Door
  332. messages. If NetUser is flagged and a message is left via PCBoard instead
  333. of a Door then the User Name will NOT be excluded and it will not count as
  334. Net Mail.
  335.  
  336. *---------------------------------------------------------------------------
  337. ;Conferences to exclude from stats (Bulletins Left, Conferences Joined and
  338. ; Conference messages left) Up to 50 entries are allowed.
  339. ;EXCLUDECONFERENCE 12
  340.  
  341. This allows you to exclude a conference from showing up in any of the reports.
  342. Exclusion is done by conference number though instead of name to simplify the
  343. program. The conferences are counted but will not show up in the lists.
  344.  
  345. *---------------------------------------------------------------------------
  346. ;Security Levels to exclude from stats (Number of Calls and Hours Used)
  347. ; Up to 50 entries are allowed.
  348. ;EXCLUDESECLEVEL 120
  349.  
  350. This allows you to exclude a security level from showing in any of the
  351. reports.
  352.  
  353. *---------------------------------------------------------------------------
  354. ;Door to exclude from stats (Doors Opened and Time Spent in Doors)
  355. ; Up to 50 entries are allowed.
  356. EXCLUDEDOOR REMOTE
  357.  
  358. This allows you to exclude Doors form being included in the reports. Time
  359. spent in the Door and opening of the Door is still counted but the Door
  360. Name will not appear in the report lists.
  361.  
  362. *---------------------------------------------------------------------------
  363. ;Label given to the Doors that are excluded. - Default = Unlisted
  364. ;NONDOORNAME Unlisted
  365.  
  366. All Excluded Doors are counted and Timed but are reported as a single entry.
  367. This variable allows defining that label. If set to a blank then they will
  368. not be reported and not added to the SaveFile at all.
  369.  
  370. *---------------------------------------------------------------------------
  371. ;Area Code for CALLER ID Report. If matched then is considered a Local Call.
  372. AREACODE 404
  373.  
  374. This is used in the Caller ID report. If the Area Code matches the one defined
  375. here, then the ID will be listed as a local call. Otgerwise, it will be listed
  376. as a long distance call.
  377.  
  378. *---------------------------------------------------------------------------
  379. ;Save filenames & counts in the history information file YES (default) or NO
  380. FILENAMES YES
  381.  
  382. If you don't wish to report files downloaded then you can save alot of file
  383. space in the SAVEFILE by setting this to NO.
  384.  
  385. *---------------------------------------------------------------------------
  386. ;File mask of files to be ignored completely, wildcards allowed
  387. ; up to 10 entries are allowed (wildcard '#' matches any digit)
  388. FILTERFILES *.GIF
  389. FILTERFILES *.TIF
  390. FILTERFILES *.PIC
  391. FILTERFILES #####?.ZIP
  392. FILTERFILES #####?.CAP
  393.  
  394. This allows preventing unwanted or sensitive filenames from being included
  395. in the files downloaded report. Wildcards are allowed and a special wildcard
  396. of '#' allows matching any digit to allow for filtering out .CAP files when
  397. using the Caller Number as the filename. They wouldn't show up in the report
  398. unless the same file was downloaded more than once (unlikely, unless you
  399. reset the Caller Number, but why include them in the total or SAVEFILE).
  400. Only 50 are provided for but if more are needed, let me know and I will
  401. increase that.
  402.  
  403. *---------------------------------------------------------------------------
  404. ;number of "User Messages Left" to report
  405. MAXUSERS 30
  406.  
  407. ;number of "User Uploads" to report
  408. MAXUL 30
  409.  
  410. ;number of "Callers Hanging Up" to report
  411. MAXHANGUP 30
  412.  
  413. ;number of "Conference Messages Left" to report
  414. MAXMSGS 20
  415.  
  416. ;number of "free downloads" to report
  417. MAXFREE 10
  418.  
  419. ;maximum number of conferences to report
  420. MAXCONF 20
  421.  
  422. ;maximum number of bulletins to report
  423. MAXBLT  20
  424.  
  425. ;maximum number of doors to report
  426. MAXDOOR 20
  427.  
  428. ;maximum number of batch sizes to report
  429. MAXBATCH 5
  430.  
  431. These control how many entries are to be reported in each report. If specified
  432. then the report will show Top xx in the report header. If not specified then
  433. all entries will be reported.
  434.  
  435. *---------------------------------------------------------------------------
  436. ;minimum d/l's to include a file in report
  437. MINDL   2
  438.  
  439. This will control which filename get reported in the Files downloaded report.
  440. Only files downloaded as many or more times as the number specified here will
  441. be reported.
  442.  
  443. *---------------------------------------------------------------------------
  444. ;redefine protocol names
  445.  
  446. PROTOCOL A Ascii (Non-Binary)
  447. PROTOCOL X Xmodem (Checksum)
  448. PROTOCOL C Xmodem (CRC)
  449. PROTOCOL O 1K-Xmodem (Ymodem)
  450. PROTOCOL F 1K-Xmodem-G(Ymodem/G)
  451. PROTOCOL Y Ymodem  (PCB Batch)
  452. PROTOCOL G Ymodem/G(PCB Batch)
  453. PROTOCOL D Ymodem  (DSZ Batch)
  454. PROTOCOL H Ymodem/G(DSZ Batch)
  455. PROTOCOL Z Zmodem  (DSZ Batch)
  456. PROTOCOL N None
  457.  
  458. This allows you to specify the Text Name used in the report for each PROTOCOL.
  459. The leter following the PROTOCOL matches that of the associated Protocol you
  460. have defined in PCBoard.
  461.  
  462. *---------------------------------------------------------------------------
  463. ;redefine Door Names   -  (I,V,C,D,G,Q,M,U)
  464. ;corresponds to report - Y(1,2,3,4,5,6,7,8)
  465. ;
  466. ; A '/' may be used to seperate Mulitple Door Names for the Same Door
  467. ;  (Note: No spaces allowed)     ie. DOOR I INSTAREG/RENEW
  468. ;
  469. DOOR I INSTAREG
  470. DOOR V VERIFY
  471. DOOR C CALLBACK/CALLME
  472. DOOR D DEPOSIT
  473. DOOR G MAIL
  474. DOOR Q QMAIL4
  475. DOOR M MM-2/MM2/MARKMAIL
  476. DOOR U REGISTER
  477.  
  478. This controls the processing of doors recoginzed specially by CALLS.EXE.
  479. The default names are shown above and if you run the door under a different
  480. name, you must specify that here or it will not be accumulated in the reports.
  481. If you run the same door under multiple names, then specify each name here
  482. seperated by a '/'.
  483.  
  484. *---------------------------------------------------------------------------
  485. ;Text to be added before the Security Level - Default = Level
  486. SECLABEL Security Level
  487.  
  488. This allows you to define what text is added to the security level for the
  489. report lines. If you want just the Security level with no other text, then
  490. just include the line SECLABEL with no text after it.
  491.  
  492. *---------------------------------------------------------------------------
  493. ;Text to be added before the Security Level - Default = ''
  494. ;if blank then line will not be printed
  495. NOSECLABEL No Security Level
  496.  
  497. This allows you to define what text is used to report caller entries with
  498. no security level. If undefined or defined as NOSECLABEL with no text after
  499. it, then this line will not be reported at all.
  500.  
  501. *---------------------------------------------------------------------------
  502. ;Maximum item length for variable length items - Default = 20
  503. ; (variable length items are defined by ITEMLEN of -1)
  504. ;
  505. ;ITEMMAX 25
  506.  
  507. This controls the maximum length that will be used of a graph item when an
  508. ITEMLEN of -1 is specified for a report.
  509.  
  510. *---------------------------------------------------------------------------
  511. ;Item length for graphs, If set to -1 then will be set to longest item
  512. ;ITEMLEN C 10
  513. ;ITEMLEN P -1
  514.  
  515. This controls the length that will be used of a graph item. This allows
  516. reducing the wasted space on the shorter reports and increasing the length
  517. of the graph bars themselves. It also allows increasing the defaults so the
  518. entire User Name would show if one exceeds the 20 character limit normally
  519. set in CALLS. The defaults are all 20 except for:
  520.  
  521. 'C'                is   8
  522. 'G', 'L' and '='  are  10
  523. 'E', 'V' and '&'  are  15
  524.  
  525. The length used will actually be 1 less than set as there is 1 space at the
  526. front of all items. The parameter after the ITEMLEN is the Report Name as
  527. listed in REPORTS and the last parameter is the length to be set. Setting
  528. a value of -1 will cause the longest length encountered to be used as long
  529. as ITEMMAX is not exceeded.
  530.  
  531. *---------------------------------------------------------------------------
  532. ;Report Title for any Report
  533. ;  Generic Mail Door - Default = Your Mail Door
  534. ;User Definable Door - Default = Any Door
  535. ;REPORTTITLE A Here's a Title
  536. REPORTTITLE Y5 Cam-Mail Door
  537. REPORTTITLE Y8 Register Door
  538.  
  539. This allows you to redefine the Header text of any of the reports you would
  540. like to. If you want a more descriptive Header than provided, you can
  541. define your own.  The parameter after the REPORTTITLE is the Report Name
  542. as listed in REPORTS and the last parameter is the title to be set.
  543.  
  544. *---------------------------------------------------------------------------
  545. ;Report Text for Reports (ANSU+# and Y1-Y10) items (1-25)
  546. ;REPORTTEXT A 2 Number of Calls Rcvd
  547.  
  548. This allows you to change the text on the fixed reports. REPORTTEXT must
  549. be followed by a space, then the Code for the report, then a space, then
  550. the item number to define, then 'a' space, then the text. Any additonal
  551. spaces before the text are considered to be part of the text. Using a
  552. CALLS.SAV file and NUL for the input file, you can quickly generate a
  553. report to see what it looks like. The item numbers start at 1 and count
  554. left to right. For the Door reports (Y1-Y10), items 1 & 2 are fixed as
  555. are the last 3 items in each report. These items can be changed by using
  556. the Code ? for the report code and item numbers are 1 to 6 as follows:
  557.  
  558. 1 Door Executed..........
  559. 2 Time in Door...........
  560. 3 .......................
  561. 4 Caller Dropped Carrier.
  562. 5 Keyboard Timeouts......
  563. 6 Logged Off in Door.....
  564.  
  565. Changing these will change ALL reports that use them. Likewise, the
  566. PCBVerify Report (Y2) and CallBack Report (3) use the same text so
  567. changing one changes the other (except for items 7 & 8). Also, the
  568. three Mail Doors (Y5, Y6 & Y7) use the same text so changes to any
  569. one will change all three.  Most text will never need changing but
  570. for those who would prefer different wording than is origionally
  571. coded into CALLS, I have provided this feature. Note: the '.'s shown
  572. above will automattically be padded to the end of what ever text you
  573. define to fill out the entry, so you don't need to include them.
  574.  
  575. *---------------------------------------------------------------------------
  576. ;redefine User Definable Door Text - (1-20)
  577. ;DEFDOOR 1 FIND THIS TEXT
  578. ;
  579. ; If not defined then the entry will not be scanned for regardless of
  580. ; DEFDOORTYPE or DEFREPORT entry. If defined then the text will be
  581. ; scanned for anywhere in the line. Order of variables can be important.
  582. ;
  583. DEFDOOR 1 ADJUSTED
  584. DEFDOOR 2 CARRIER LOST
  585. DEFDOOR 3 KEYBOARD TIMEOUT
  586.  
  587. This allows you to define the text that is scanned for for a Door defined
  588. by yourself. This Door corresponds to the DOOR U DoorName entry (or REPORT
  589. Y8). You may define up to text entries to be recognized. Use as much or as
  590. little of the text you need to identify a particular line from another. The
  591. number corresponds to the 20 variables set aside for the door report. If the
  592. text you specify is found then the variable will be incremented. Undefined
  593. (unused) text entries will not be scanned for.
  594.  
  595. *---------------------------------------------------------------------------
  596. ;redefine User Definable Door Variable Type - (1-20)
  597. ;DEFDOORTYPE 1 1
  598. ;
  599. ; When DEFDOOR is defined:
  600. ; Bit 2 means Carrier lost, Doesn't count if Door Logged User Off
  601. ; Bit 4 means Door Logged User Off
  602. ; Bit 8 means Line contains HH:MM entry to stop Door Timing
  603. ;
  604. ; When DEFREPORT is NOT defined:
  605. ; Assigning a  1 means show '  .......................       '
  606. ; Assigning a -1 means show '                                '
  607. ;
  608. DEFDOORTYPE 1 1
  609. DEFDOORTYPE 2 2
  610. DEFDOORTYPE 3 1
  611.  
  612. This controls special aspects of the variables. It is 'bit' controlled and
  613. you can include all or none of the bits.  The bit meanings are described above.
  614. The real use is to recoginze a CARRIER LOS entry so it can be counted properly
  615. for the report. Also, if there is a line issued by the door that would indicate
  616. that the door was dropping carrier or loggin the user off, this prevents CALLS
  617. from counting a CARRIER LOST against the User. Allowance is also given to
  618. tell CALLS to stop timing the door on a given entry. One such line exists
  619. in PCBVerify as 'User disconnected at (HH:MM:SS)' so setting an entry to 12
  620. would cause CALLS to recoginze that timing of the door can stop and that
  621. a subsequent CARRIER LOST should be ignored (until a Minutes Used or a
  622. Back From Dos at HH:MM line appears to indicate the door data has ended.
  623.  
  624. If a variable is unused you can use DEFDOORTYPE to cause a blank line to
  625. be generated by setting as descibed above. This allows for flexible report
  626. output to be designed. Although only 1 User Definable report is allowed, you
  627. can combine multiple doors under it by defining DOOR U Door1/Door2/Door3
  628. and then using the first several variables for Door1, skip 2 variables, use
  629. some for Door2, skip 2 and then Use more for Door3. Setting the skipped
  630. variables DEFDOORTYPE to -1 will cause a seperating blankline. Only a single
  631. Number of times Door Opened, Time in Door, etc... report will be generated
  632. and represent all doors combined.
  633.  
  634. *---------------------------------------------------------------------------
  635. ;redefine User Definable Door Report Text - (1-20)
  636. ;DEFREPORT 1 Found the text
  637. ;
  638. ; If not defined then the entry will not be Reported, unless DEFDOORTYPE
  639. ; is defined in which case a blank entry will be reported.
  640. ;
  641. DEFREPORT 1 Security Level Adjusted
  642. DEFREPORT 2 Caller Dropped Carrier
  643. DEFREPORT 3 Keyboard Timeouts
  644.  
  645. This allows you to specify teh text that appears in the report itself for
  646. each variable. Blank (or unused) lines will not be printed (with the noted
  647. exception of the 1, -1 DEFDOORTYPE mentioned above)
  648.  
  649. *---------------------------------------------------------------------------
  650. ;Include Refused to Register and Access Denied - Refused Registration
  651. REFUSEDREG NO
  652.  
  653. This allows you to have the two figures combined and reported under Refused
  654. to Register. The purpose for this is for those of us who allow Users to
  655. remain on the BBS at a reduced level if they don't register. PCBoard generates
  656. a Refused to Register entry and CALLS uses that to generate a Non-Registered
  657. Users report. Only those Users who refuse to give a full name after starting
  658. a name entry or refuse to answer the questions after starting registration
  659. cause a Access Denied - Refused Registration wntry to be generated which CALLS
  660. uses to generate a Refused to Register report for. If you have the level set
  661. to 0 for these users, then PCBoard will kick them off and you will get a
  662. Refused to Register entry in the log for them. Setting REFUSEDREG YES will
  663. cause CALLS to report both entries under Refused to Register (although the
  664. entries will still be reported under Non-Registered Users also.)
  665.  
  666. *---------------------------------------------------------------------------
  667. ;redefine Language Names - 20 characters max - (1 - 30)
  668. ;LANGUAGE 5 Three Stooges    (5)
  669. LANGUAGE 1 English [Default](1)
  670. LANGUAGE 2 Southern Style   (2)
  671. LANGUAGE 3 Three Stooges    (3)
  672.  
  673. This allows you to define the name of the languges reported by CALLS to
  674. what you call them in PCBML.DAT file.
  675.  
  676. *---------------------------------------------------------------------------
  677. ;define how event time is reported
  678. ;   EVENTMODE OFF disables calculation of event duration.
  679. ;   EVENTMODE BUSY calculates event duration and accounts for it
  680. ;       as 'busy' time (i.e. the system was in use during this time).
  681. ;   EVENTMODE IDLE calculates event duration and accounts for it
  682. ;       as 'idle' time (i.e. the system was NOT in use during this time).
  683. EVENTMODE BUSY
  684.  
  685. This allows you to consder the BBS IDLE or BUSY during the time the Event is
  686. running.
  687.  
  688. *---------------------------------------------------------------------------
  689. ;define how Sysop chat time is reported
  690. ;   CHATMODE OFF disables calculation of Sysop chat duration.
  691. ;   CHATMODE BUSY calculates Sysop chat duration and accounts for it
  692. ;       as 'busy' time (i.e. the system was in use during this time).
  693. ;   CHATMODE IDLE calculates Sysop chat duration and accounts for it
  694. ;       as 'idle' time (i.e. the system was NOT in use during this time).
  695. CHATMODE IDLE
  696.  
  697. This was intended to allow you to define the BBS IDLE or BUSY during the
  698. time the User was in Chat with the Sysop but it is not correct. It should
  699. be set to IDLE or the figures might not be correct. I added it as it is
  700. possible not to charge the User for time spent in chat but this really
  701. didn't affect the Minutes Used time reported in the Caller log, only how
  702. much time he was charged in the User file. I will probably remove this
  703. section at a later date or fix it to work by subtrating time if set to IDLE
  704. so when time is added at the minutes used line, it will have been cancelled
  705. out already. I also left it in as it does allow suppresion of the time in
  706. chat line if set to OFF
  707.  
  708. *---------------------------------------------------------------------------
  709. ;define how Node chat time is reported
  710. ;   NODEMODE OFF disables calculation of Node chat duration.
  711. ;   NODEMODE BUSY calculates Node chat duration and accounts for it
  712. ;       as 'busy' time (i.e. the system was in use during this time).
  713. ;   NODEMODE IDLE calculates Node chat duration and accounts for it
  714. ;       as 'idle' time (i.e. the system was NOT in use during this time).
  715. NODEMODE IDLE
  716.  
  717. This should be set to IDLE also for now as it has the same problem as above
  718. and was added just to be compatible with CHATMODE.
  719.  
  720. *---------------------------------------------------------------------------
  721. ;Enable filtering of Modem return data
  722. RINGFILTER ON
  723.  
  724. Sometimes the Modem returns more that just the baud rate in the way of line
  725. noise. This causes unusal reports. Also on some office phone systems it is
  726. posibble to get a double ring and a RING appears before the resulting in
  727. such entries as:
  728.  
  729.       Modem: CONNECT 2400 D D C C C
  730.       Modem: CONNECT 2400 ? ? ?
  731.       Modem: RING CONNECT 2400
  732.  
  733. which throws off the report. Setting RINGFILTER ON will cause the word RING
  734. to be filtered out of the line and the connect string will be truncated at
  735. the first space past the 'CONNECT XXXXX'.
  736.  
  737. *---------------------------------------------------------------------------
  738. ;Enable filtering of CONNECT from Modem return data - Default = OFF
  739. ;CONNECTFILTER NEW
  740. CONNECTFILTER ON
  741.  
  742. Some modems return much longer Connect strings and CALLS truncates the string
  743. making it less readable. Setting CONNECTFILTER to ON causes the word CONNECT
  744. to be eliminated from the string, allowing more room for useful text. If the
  745. string contains only the word CONNECT then it will not be removed (or else it
  746. will cause a problem with the CALLS.SAV file being read back in due to the
  747. blank line, which is normally means the end of a list has been reached.) If
  748. you have a CALLS.SAV file and do not want to regenerate it, you can edit out
  749. the CONNECT portion of the string manually (but don't elminate it on the
  750. string containing only CONNECT as mentioned above, causing a blank line)
  751. If the Connect string contains a CARRIER and a CONNECT then if CONNECTFILTER
  752. is active, the CARRIER will be filtered out and the entire CONNECT XXXXX will
  753. be filtered out. If set to NEW then CONNECT or CARRIER will be stripped from
  754. the beggining the same way Sam added to 14s24.
  755.  
  756. *---------------------------------------------------------------------------
  757. ;Count all (Local) connect types as SYSOP local sessions. - Default = NO
  758. ;ALL_LOCAL YES
  759.  
  760. If set to YES then ALL (Local) sessions will be counted as SYSOP Local
  761. sessions regardless of the User Name of the logon.
  762.  
  763. *---------------------------------------------------------------------------
  764. ;Don't count Failed Verification files as Uploads or as a User Upload
  765. ;  NO means just count it as a failure (Default)
  766. ; YES means subtract from the Upload count also
  767. ;USER means subtract from the User Uploads count also
  768. ;BOTH means subtract from Upload count & User count also
  769. UPLOADFAILED BOTH
  770.  
  771. This allows you to not count uploads that fail verification. It also allows
  772. you to not count such uploads 'credited' to a User. Those Sysops who use
  773. CALLS to generate a bulletin showing Top User Uploads will like this. The
  774. only known problem with doing this is when a User uploads a file that fails,
  775. their name will appear in the bulletin as having uploaded Zero files if they
  776. only upload one file and it fails. It was too much trouble to try to figure
  777. out how to remove the entry from the chain. I will make a future modification
  778. to skip '0' entries on the reporting end of it. As long as there are enough
  779. Users uploading to push the Zeros off the report, you won't even see the names.
  780.  
  781. ==============================================================================
  782. Of course, despite the fact that the title screen still says support is from
  783. Samuel H. Smith, please don't refer questions regarding features added in this
  784. version to him. I will field all support questions for the changes I made.
  785.  
  786.                                                                 Gary Meeker
  787.